largebinarystream.htmlHTMLudogL©πùΔ£πùΔ£ÅÅ£H Monkeybread Realbasic plugin - Documentation - LargeBinaryStream

MBS Plugin Documentation

This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.

This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.

The list of the themes Global methods by category Global methods by name The list of the classes The list of the controls

class LargeBinaryStream
class, Large binary stream Sa, 27. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Allows you to access files with more than 2GB in size.

Allocate(count as double, flags as integer) as double
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: Allocates disk space for this file.
Example: d=l.Allocate(1024*1024*1024,2) // 1 GB
Notes:
The flags can be like this:
AllocDefaultFlags0as much as possible, not contiguous
AllocAllOrNothingMask1allocate all of the space, or nothing
AllocContiguousMask2new space must be one contiguous piece
AllocNoRoundUpMask4don't round up allocation to clump size
Note that the length property is not changed because the space is not used.

CanWrite as boolean
property, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns true if you are allowed to write.
Notes: Even if you open a file for write you may still not be allowed to write if the permissions of the file don't allow you to write.

Close
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Closes this object.
Notes: The destructor closes a LargeBinaryStream if you don't close it.

EOF as boolean
property, Large binary stream Sa, 27. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns true if you are at the end of the stream.
Notes: You can set this property to truncate the file.

Length as Double
property, Large binary stream Sa, 27. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the current length of the file.
Notes: You can truncate the stream by setting this property.

LittleEndian as boolean
property, Large binary stream Sa, 27. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Specifies if Integers and Shorts shall be converted in their endienness when read or written.
Notes:
See Realbasics binarystream for more details.
For native platform you may set "littleendian=targetwin32".

noCache as boolean
property, Large binary stream Sa, 27. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: whether not to use a read/write cache.
Notes:
Not sure if this flag is supported on Mac OS X, which has a really big file cache. (Should be all available RAM)
noCache could be added for Windows on request.

Position as Double
property, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns current position.
Notes: You can set the current file stream position using this property.

Read(amount as Integer) as string
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Reads bytes into a string.
Example:
dim s as string
...
s=b.read(5)

ReadBlock(amount as Integer) as memoryblock
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Reads bytes into a memoryblock.
Example:
dim s as memoryblock
...
s=b.read(5)

Readbyte as integer
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Reads an 8bit Byte from the stream.
Example:
dim i as integer
...
i=B.readbyte

ReadLong as integer
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Reads a signed 32bit Integer from the stream.
Example:
dim i as integer
...
i=B.readlong
Notes: This function is affected by the LittleEndian Setting.

ReadPString as string
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Reads a pascal string from the file.
Example:
dim s as string
...
s=b.readpstring
Notes:
A Pascal String is a signle byte for the length of the string followed by the bytes which are the content of the string.
Dynamical length between 0 and 255 bytes which allways needs between 1 and 256 bytes to store on disk.

ReadShort as integer
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Reads a signed 16bit Integer from the stream.
Example:
dim i as integer
...
i=B.readshort
Notes: This function is affected by the LittleEndian Setting.

Write(data as string)
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Writes bytes from a string to file.

WriteBlock(data as memoryblock,count as integeer)
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Writes count bytes from a memoryblock to file.
Example:
dim m as memoryblock
...
b.writeblock m,size

WriteByte(data as integer)
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Writes a byte to file.

WriteLong(data as integer)
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Writes an 32bit integer to file.
Notes: This method is affected by the LittleEndian Setting.

WritePString(data as string)
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Writes a Pascal String to disk.

WriteShort(data as integer)
method, Large binary stream Mo, 15. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Writes an 16bit integer to file.
Notes: This method is affected by the LittleEndian Setting.

Contact

Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.

This resource fork intentionally left blank ˇˇ